CxUisEditor Methods

The CxUisEditor object contains the following methods:

Connect
Copy
Delete
Disconnect
Edit
New
ViewCD
ViewED
ViewRD

Connect

The Connect method connects the object to a service.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter	Required	Description
DomainSiteService	Yes	The [Domain]Site.Service to which to connect. The domain is optional. The service must be a valid one.

Remarks

Returns 0 if successful and a non-zero value if the connection failed.

Example

The following example connects the Client object to the CYGDEMO.<SVC> on domain 5410:

Copy

Connect

1
2
3
4
5
6
7
Sub

    Dim UisEditor
    Set UisEditor = CreateObject("CxEditors.CxUisEditor")
    UisEditor.Connect("[5410]CYGDEMO.UIS")

End Sub

Copy

The Copy method launches a New dialog box initialized with the information in the specified record.

Syntax

Copy(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to copy.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches a Copy or New dialog box for the record "0000012345."

Copy

1
2
3
4
5
6
7
8
Sub Copy()

    Dim iRet
    iRet = <SvcClient>.Copy("0000012345")
 
    MsgBox iRet

End Sub

Delete

The Delete method launches a dialog box initialized with the information in the specified database queue key.

Syntax

Delete(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to delete.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified Delete dialog box for record "0000012345":

Copy

Delete

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.Delete("0000012345")
 
    MsgBox iRet
    
End Sub

Disconnect

The Disconnect method disconnects from the connected service.

Syntax

Disconnect() As Integer

Remarks

The Disconnect method returns 0 if successful and a non-zero value if the disconnect failed.

Example

The following example disconnects the Client object from the connected service, and pops a message box if it is unsuccessful:

Copy

Disconnect

1
2
3
4
5
6
7
8
9
10
11
Sub Svc.Disconnect()
 
    <SvcClient>.Disconnect()
    MsgBox "Service has disconnected."
    
    If <SvcClient>.Disconnect <> 0 
    Then
        MsgBox "Failed to disconnect."
    End If

End Sub

Edit

The Edit method launches an editor dialog box initialized with the information in the specified record.

Syntax

Edit(ByVal QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches a dialog box for record "CYGDEMO.UIS.0000012345".

Copy

Edit

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet= CvsEditor.Edit("CYGDEMO.UIS.0000012345")
    MsgBox iRet


End Sub

New

The New method launches a New dialog box.

Syntax

New() As Integer

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified editor dialog box:

Copy

New

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.New
 
    MsgBox iRet
    
End Sub

ViewCD

The ViewCD method launches a Device Information dialog box for the specified Comm Device.

Syntax

ViewCD(strDeviceId As String) As Integer

Parameters

Parameter	Required	Description
strDeviceId	Yes	The ID of the Comm Device to view.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	The dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "TCP210-3001."

Copy

ViewCD

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet= UisEditor.ViewCD("TCP210-3001")
    MsgBox iRet

End Sub

ViewED

The ViewED method launches a Device Information dialog box for the specified Import/Export Device.

Syntax

ViewED(strDeviceId As String) As Integer

Parameters

Parameter	Required	Description
strDeviceId	Yes	The ID of the Import/Export Device to view.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	The dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "ENTOPS."

Copy

ViewED

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet= UisEditor.ViewED("ENTOPS")
    MsgBox iRet

End Sub

ViewRD

The ViewRD method launches a Device Information dialog box for the specified remote device.

Syntax

ViewRD(strDeviceId As String) As Integer

Parameters

Parameter	Required	Description
strDeviceId	Yes	The ID of the remote device to view.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	The dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "FLOWAUTOAP15."

Copy

ViewRD

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet= UisEditor.ViewRD("FLOWAUTOAP15")
    MsgBox iRet

End Sub